-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add External Source (and External Event) Attribute Validation #1560
base: develop
Are you sure you want to change the base?
Conversation
e54c8a4
to
a0ec888
Compare
…/source types in schema
…y, improve error handling
Set.intersection() isn't supported in the current version of Svelte/TS
d110c02
to
4213b2a
Compare
Fixed the example products - they were a bit out-of-date with our latest schema work! |
Quality Gate failedFailed conditions |
___REQUIRES_AERIE_PR___="1606"
___REQUIRES_GATEWAY_PR___="116"
Description
This PR adds external source and event attribute validation to AERIE.
It is explained more in depth here.
The main updates to the UI for this PR surround the displaying of source and event attributes in the UI, namely in the External Source Manager, as well as an external source/event type creation page (previously Modals). Derivation group creation has presently been moved out of a modal and is delegated to the
Derivation Group
field where sources are uploaded.Below is a view of the new 'External Types Manager' with an External Source Type's attribute schema being shown:
Below is a view of an External Event's attributes being shown:
Walkthrough
Upload
To use this feature, navigate to the
External Sources
page of AerieSelect the
Types
button in the top-right to switch to the/types
sub-page.Click the 'Choose File' button and select a complete External Source & Event type schema (see bottom of this section for an example file). The pane should display the External Source & Event types that will be created once the 'Upload' button has been clicked - click the 'Upload' button to submit & create the types.
After the types have been created, a source can be uploaded by clicking the
Sources
button in the top-right, then selecting theChoose File
button in the left-pane, selecting the related External Source, and clickingUpload
.Viewing Schemas
The attribute schema for an uploaded External Event or Source Type can be viewed by navigating to the
External Sources
page and selecting theTypes
button in the top-right to switch to the/types
sub-page.Once on the
Types
page, select the tab for the desired type (Event
orSource
) and then hover the row containing the desired type. Click theView
button that appears. On the left-pane, the type should be displayed with two collapsible categories forAttribute Schema - Definition
andAttribute Schema - Properties
.Definition
contains any top-level fields included other thanProperties
, which is shown under the other collapse.Viewing Attributes
The attributes of a given External Source or Event can be seen by navigating to the
External Sources
page, hovering over the row for the desired External Source, and clicking theView
button. In theSelected External Source
pane on the left, there is a section forAttributes
which when clicked will show the specific attributes for the given source.Example Files
Example External Source Schema:
weather-schema.json
Example External Source:
WEATHER_2024001_2024008_IDEAL.V00.json